Skip to content

Add agent contribution guidance#534

Open
bubaizhanshen wants to merge 1 commit into
BoboTiG:mainfrom
bubaizhanshen:add-agent-contribution-guidance
Open

Add agent contribution guidance#534
bubaizhanshen wants to merge 1 commit into
BoboTiG:mainfrom
bubaizhanshen:add-agent-contribution-guidance

Conversation

@bubaizhanshen

Copy link
Copy Markdown

Changes proposed in this PR

Fixes #510

  • Add a top-level AGENTS.md with repository layout, working guidelines, and validation commands for coding agents

  • Add an AI assistance disclosure section to the pull request template

  • Tests added/updated (not applicable; repository metadata only)

  • Documentation updated

  • Changelog entry added (not applicable; contributor process only)

  • ./check.sh passed

AI assistance disclosure

  • No AI assistance was used.
  • AI assistance was used partially or completely.

If AI assistance was used, describe what it was used for:

Codex helped draft the AGENTS.md and PR-template wording, then I reviewed the final diff and ran ./check.sh locally.

@jholveck

jholveck commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Adding @halldorfannar for visibility; he's working on something similar, based on his and my work with MSS.

@halldorfannar

Copy link
Copy Markdown
Contributor

Why was this closed?

@bubaizhanshen bubaizhanshen reopened this Jun 11, 2026
@bubaizhanshen

Copy link
Copy Markdown
Author

I closed it to avoid duplicating similar work after @jholveck mentioned @halldorfannar was working in the same area. I reopened it so maintainers can decide whether it is useful or should be superseded by the other work.

@halldorfannar halldorfannar left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Only one nit. Let's get this submitted and I will then expand it with a few additions.

### AI assistance disclosure

- [ ] No AI assistance was used.
- [ ] AI assistance was used partially or completely.

@halldorfannar halldorfannar Jun 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first checkbox is sufficient - "No AI assistance was used to generate this contribution."

Please remove the second option. Also, leave out the additional text below - people/AI can elaborate on what the AI was used for if they want to. We don't need to encourage it. We want to keep these templates as light as possible.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might add a note that AI assistance is permitted, as long as a human has reviewed it. The other checkboxes are mandatory; this one is optional.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Adjustments for AI assisted programming

3 participants